Criar um Cliente PF

Quando um Cliente é criado com sucesso, a API retorna o código de status HTTP 201 Created, com os dados cliente criado no corpo da resposta.

Segurança

Para acessar a API, é necessário obter um token de acesso através do fluxo de autenticação OAuth2. Veja mais detalhes em Como obter acesso?

info

Ao gerar o token JWT, não esqueça de utilizar o escopo correto. Caso contrário, a requisição será rejeitada com o código de erro 401 Unauthorized.

Descrição dos campos

Campo	Tipo	Descrição
partnerId	string	ID do parceiro cadastrado préviamente
name	string	Nome do cliente.
birthDate	string	Opcional, Data de nascimento, no formato:YYYY-MM-DD
taxId.type	string	Identificador do tipo de documento, utilizado para identificar o tipo de documento inserido.
taxId.value	string	Documento do cliente

Requisição

POST https://api-sandbox.catalisa.com.br/entities/api/v1/people JWT scope: customers/create:peoples

Parâmetros

Sem parâmetros

Cabeçalhos

Nome	Valor
Authorization	Bearer <token>
Content-Type	application/json

Exemplo de Requisição

Corpo da Requisição

{
  "data": {
    "type": "people",
    "attributes": {
      "partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
      "name": "Laverne O'Connell",
      "taxId": {
        "type": "BR_CPF",
        "value": "348.781.040-90"
      }
    }
  }
}

Respostas

Código	Descrição
201	Cliente criado com sucesso. Retorna os dados da cliente criado.
401	Não autorizado

Exemplo de uso

Javascript

const headers = new Headers();
headers.append("Authorization", "Bearer <token>");
headers.append("Content-Type", "application/json");

const body = JSON.stringify({
  data: {
    type: "people",
    attributes: {
      partnerId: "f41b03a3-a865-4c60-852b-309b3ebbe344",
      name: "Laverne O'Connell",
      taxId: {
        type: "BR_CPF",
        value: "348.781.040-90",
      },
    },
  },
});

const requestOptions = {
  method: "POST",
  headers: headers,
  body: body,
};

const response = await fetch(
  "https://api-sandbox.catalisa.com.br/entities/api/v1/people",
  requestOptions
);
const data = await response.json();
console.log(data);

CURL

curl --location --request POST 'https://api-sandbox.catalisa.com.br/entities/api/v1/people' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
--data-raw '{
	"data": {
		"type": "people",
		"attributes": {
			"partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
			"name": "Laverne O'Connell",
			"taxId": {
				"type": "BR_CPF",
				"value": "348.781.040-90"
			}
		}
	}
}'

Exemplo de Sucesso

{
  "links": {
    "self": "https://api-dev.catalisa.com.br/entities/api/v1/people/eb2eabc5-b316-4c1e-9fca-09684db6ca90"
  },
  "data": {
    "type": "people",
    "id": "eb2eabc5-b316-4c1e-9fca-09684db6ca90",
    "attributes": {
      "partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
      "name": "Laverne O'Connell",
      "taxId": {
        "type": "BR_CPF",
        "value": "348.781.040-90"
      },
      "birthDate": null,
      "active": true
    }
  }
}